Class PoolImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.PoolImpl
All Implemented Interfaces:
IPCObject, Pool
Direct Known Subclasses:
IPPoolImpl, NumberPoolImpl, StringPoolImpl

public class PoolImpl extends IPCObjectImpl implements Pool
Information provided by the PKI file:

    \class Pool
    
    \brief Pool is the base class for all variable pools for activities.
    
    \example appWindow().getActiveFile().getVariableManager().getIpPoolAt(0)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • name

      public String name()
      Information provided by the PKI file:
      
          \brief Returns the name of the pool.
          
          \return QString, the name of the pool.
          
              
      Specified by:
      name in interface Pool
      Returns:
      String Returns a String
    • getElementToString

      public String getElementToString(int index)
      Information provided by the PKI file:
      
          \brief Returns the element in the pool at the specified index.
          
          \param index, the index of the element in the pool of interest.
          
          \return QString, the element in the pool at the specified index.
          
              
      Specified by:
      getElementToString in interface Pool
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • isInPool

      public boolean isInPool(String value)
      Information provided by the PKI file:
      
          \brief Returns true if the specified value is in the pool, otherwise false.
          
          \param value, value to find in the pool.
          
          \return bool, true if the specified value is in the pool, otherwise false.
          
              
      Specified by:
      isInPool in interface Pool
      Parameters:
      value - Takes in a parameter of value
      Returns:
      boolean Returns a boolean